home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 15 / CU Amiga Magazine's Super CD-ROM 15 (1997)(EMAP Images)(GB)[!][issue 1997-10].iso / CUCD / Graphics / Ghostscript / source / idparam.c < prev    next >
C/C++ Source or Header  |  1997-03-03  |  10KB  |  343 lines
  1. /* Copyright (C) 1992, 1995, 1997 Aladdin Enterprises.  All rights reserved.
  2.   
  3.   This file is part of Aladdin Ghostscript.
  4.   
  5.   Aladdin Ghostscript is distributed with NO WARRANTY OF ANY KIND.  No author
  6.   or distributor accepts any responsibility for the consequences of using it,
  7.   or for whether it serves any particular purpose or works at all, unless he
  8.   or she says so in writing.  Refer to the Aladdin Ghostscript Free Public
  9.   License (the "License") for full details.
  10.   
  11.   Every copy of Aladdin Ghostscript must include a copy of the License,
  12.   normally in a plain ASCII text file named PUBLIC.  The License grants you
  13.   the right to copy, modify and redistribute Aladdin Ghostscript, but only
  14.   under certain conditions described in the License.  Among other things, the
  15.   License requires that the copyright notice and this notice be preserved on
  16.   all copies.
  17. */
  18.  
  19. /* idparam.c */
  20. /* Utilities for getting parameters out of dictionaries. */
  21. #include "memory_.h"
  22. #include "string_.h"        /* for strlen */
  23. #include "ghost.h"
  24. #include "errors.h"
  25. #include "gsmatrix.h"        /* for dict_matrix_param */
  26. #include "gsuid.h"
  27. #include "idict.h"
  28. #include "idparam.h"        /* interface definition */
  29. #include "ilevel.h"
  30. #include "imemory.h"        /* for iutil.h */
  31. #include "iname.h"
  32. #include "iutil.h"
  33. #include "oper.h"        /* for check_proc */
  34. #include "store.h"        /* for making empty proc */
  35.  
  36. /* Get a Boolean parameter from a dictionary. */
  37. /* Return 0 if found, 1 if defaulted, <0 if wrong type. */
  38. int
  39. dict_bool_param(const ref *pdict, const char _ds *kstr,
  40.   bool defaultval, bool *pvalue)
  41. {    ref *pdval;
  42.     if ( pdict == 0 || dict_find_string(pdict, kstr, &pdval) <= 0 )
  43.     {    *pvalue = defaultval;
  44.         return 1;
  45.     }
  46.     if ( !r_has_type(pdval, t_boolean) )
  47.         return_error(e_typecheck);
  48.     *pvalue = pdval->value.boolval;
  49.     return 0;
  50. }        
  51.  
  52. /* Get an integer or null parameter from a dictionary. */
  53. /* Return 0 if found, 1 if defaulted, <0 if invalid. */
  54. /* If the parameter is null, return 2 without setting *pvalue. */
  55. /* Note that the default value may be out of range, in which case */
  56. /* a missing value will return e_rangecheck rather than 1. */
  57. int
  58. dict_int_null_param(const ref *pdict, const char _ds *kstr, int minval,
  59.   int maxval, int defaultval, int *pvalue)
  60. {    ref *pdval;
  61.     int code;
  62.     long ival;
  63.     if ( pdict == 0 || dict_find_string(pdict, kstr, &pdval) <= 0 )
  64.     {    ival = defaultval;
  65.         code = 1;
  66.     }
  67.     else
  68.     {    switch ( r_type(pdval) )
  69.         {
  70.         case t_integer:
  71.             ival = pdval->value.intval;
  72.             break;
  73.         case t_real:
  74.             /* Allow an integral real, because Fontographer */
  75.             /* (which violates the Adobe specs in other ways */
  76.             /* as well) sometimes generates output that */
  77.             /* needs this. */
  78.             if ( pdval->value.realval < minval || pdval->value.realval > maxval )
  79.                 return_error(e_rangecheck);
  80.             ival = (long)pdval->value.realval;
  81.             if ( ival != pdval->value.realval )
  82.                 return_error(e_rangecheck);
  83.             break;
  84.         case t_null:
  85.             return 2;
  86.         default:
  87.             return_error(e_typecheck);
  88.         }
  89.         code = 0;
  90.     }
  91.     if ( ival < minval || ival > maxval )
  92.         return_error(e_rangecheck);
  93.     *pvalue = (int)ival;
  94.     return code;
  95. }        
  96. /* Get an integer parameter from a dictionary. */
  97. /* Return like dict_int_null_param, but return e_typecheck for null. */
  98. int
  99. dict_int_param(const ref *pdict, const char _ds *kstr, int minval, int maxval,
  100.   int defaultval, int *pvalue)
  101. {    int code = dict_int_null_param(pdict, kstr, minval, maxval,
  102.                        defaultval, pvalue);
  103.     return (code == 2 ? gs_note_error(e_typecheck) : code);
  104. }
  105.  
  106. /* Get an unsigned integer parameter from a dictionary. */
  107. /* Return 0 if found, 1 if defaulted, <0 if invalid. */
  108. /* Note that the default value may be out of range, in which case */
  109. /* a missing value will return e_rangecheck rather than 1. */
  110. int
  111. dict_uint_param(const ref *pdict, const char _ds *kstr,
  112.   uint minval, uint maxval, uint defaultval, uint *pvalue)
  113. {    ref *pdval;
  114.     int code;
  115.     uint ival;
  116.     if ( pdict == 0 || dict_find_string(pdict, kstr, &pdval) <= 0 )
  117.     {    ival = defaultval;
  118.         code = 1;
  119.     }
  120.     else
  121.     {    check_type_only(*pdval, t_integer);
  122.         if ( pdval->value.intval != (uint)pdval->value.intval )
  123.             return_error(e_rangecheck);
  124.         ival = (uint)pdval->value.intval;
  125.         code = 0;
  126.     }
  127.     if ( ival < minval || ival > maxval )
  128.         return_error(e_rangecheck);
  129.     *pvalue = ival;
  130.     return code;
  131. }        
  132.  
  133. /* Get a float parameter from a dictionary. */
  134. /* Return 0 if found, 1 if defaulted, <0 if wrong type. */
  135. int
  136. dict_float_param(const ref *pdict, const char _ds *kstr,
  137.   floatp defaultval, float *pvalue)
  138. {    ref *pdval;
  139.     if ( pdict == 0 || dict_find_string(pdict, kstr, &pdval) <= 0 )
  140.     {    *pvalue = defaultval;
  141.         return 1;
  142.     }
  143.     switch ( r_type(pdval) )
  144.     {
  145.     case t_integer: *pvalue = pdval->value.intval; return 0;
  146.     case t_real: *pvalue = pdval->value.realval; return 0;
  147.     }
  148.     return_error(e_typecheck);
  149. }        
  150.  
  151. /* Get an integer array from a dictionary. */
  152. /* Return the element count if OK, 0 if missing, <0 if invalid. */
  153. int
  154. dict_int_array_param(const ref *pdict, const char _ds *kstr,
  155.   uint maxlen, int *ivec)
  156. {    ref *pdval;
  157.     const ref *pa;
  158.     int *pi = ivec;
  159.     uint size;
  160.     int i;
  161.     if ( pdict == 0 || dict_find_string(pdict, kstr, &pdval) <= 0 )
  162.         return 0;
  163.     if ( !r_has_type(pdval, t_array) )
  164.         return_error(e_typecheck);
  165.     size = r_size(pdval);
  166.     if ( size > maxlen )
  167.         return_error(e_limitcheck);
  168.     pa = pdval->value.const_refs;
  169.     for ( i = 0; i < size; i++, pa++, pi++ )
  170.        {    /* See dict_int_param above for why we allow reals here. */
  171.         switch ( r_type(pa) )
  172.         {
  173.         case t_integer:
  174.             if ( pa->value.intval != (int)pa->value.intval )
  175.                 return_error(e_rangecheck);
  176.             *pi = (int)pa->value.intval;
  177.             break;
  178.         case t_real:
  179.             if ( pa->value.realval < min_int ||
  180.                  pa->value.realval > max_int ||
  181.                  pa->value.realval != (int)pa->value.realval
  182.                )
  183.                 return_error(e_rangecheck);
  184.             *pi = (int)pa->value.realval;
  185.             break;
  186.         default:
  187.             return_error(e_typecheck);
  188.         }
  189.        }
  190.     return size;
  191. }        
  192.  
  193. /* Get a float array from a dictionary. */
  194. /* Return the element count if OK, <0 if invalid. */
  195. /* If the parameter is missing, then if defaultvec is NULL, return 0; */
  196. /* if defaultvec is not NULL, copy it into fvec (maxlen elements) */
  197. /* and return maxlen. */
  198. int
  199. dict_float_array_param(const ref *pdict, const char _ds *kstr,
  200.   uint maxlen, float *fvec, const float *defaultvec)
  201. {    ref *pdval;
  202.     uint size;
  203.     int code;
  204.     if ( pdict == 0 || dict_find_string(pdict, kstr, &pdval) <= 0 )
  205.     {    if ( defaultvec == NULL ) return 0;
  206.         memcpy(fvec, defaultvec, maxlen * sizeof(float));
  207.         return maxlen;
  208.     }
  209.     if ( !r_has_type(pdval, t_array) )
  210.         return_error(e_typecheck);
  211.     size = r_size(pdval);
  212.     if ( size > maxlen )
  213.         return_error(e_limitcheck);
  214.     code = num_params(pdval->value.refs + size - 1, size, fvec);
  215.     return (code >= 0 ? size : code);
  216. }        
  217.  
  218. /*
  219.  * Get a procedure from a dictionary.  If the key is missing,
  220.  *    defaultval = false means substitute t__invalid;
  221.  *    defaultval = true means substitute an empty procedure.
  222.  * In either case, return 1.
  223.  */
  224. int
  225. dict_proc_param(const ref *pdict, const char _ds *kstr, ref *pproc,
  226.   bool defaultval)
  227. {    ref *pdval;
  228.     if ( pdict == 0 || dict_find_string(pdict, kstr, &pdval) <= 0 )
  229.     {    if ( defaultval )
  230.           make_empty_const_array(pproc, a_readonly + a_executable);
  231.         else
  232.           make_t(pproc, t__invalid);
  233.         return 1;
  234.     }
  235.     check_proc(*pdval);
  236.     *pproc = *pdval;
  237.     return 0;
  238. }
  239.  
  240. /* Get a matrix from a dictionary. */
  241. int
  242. dict_matrix_param(const ref *pdict, const char _ds *kstr, gs_matrix *pmat)
  243. {    ref *pdval;
  244.     if ( pdict == 0 || dict_find_string(pdict, kstr, &pdval) <= 0 )
  245.         return_error(e_typecheck);
  246.     return read_matrix(pdval, pmat);
  247. }
  248.  
  249. /* Get a UniqueID or XUID from a dictionary. */
  250. /* Return 0 if UniqueID, 1 if XUID, <0 if error. */
  251. /* If there is no uid, return default. */
  252. int
  253. dict_uid_param(const ref *pdict, gs_uid *puid, int defaultval,
  254.   gs_memory_t *mem)
  255. {    ref *puniqueid;
  256.     if ( pdict == 0 )
  257.     {    uid_set_invalid(puid);
  258.         return defaultval;
  259.     }
  260.     /* In a Level 2 environment, check for XUID first. */
  261.     if ( level2_enabled &&
  262.          dict_find_string(pdict, "XUID", &puniqueid) > 0
  263.        )
  264.     {    long *xvalues;
  265.         uint size, i;
  266.         if ( !r_has_type(puniqueid, t_array) )
  267.             return_error(e_typecheck);
  268.         size = r_size(puniqueid);
  269.         if ( size == 0 )
  270.             return_error(e_rangecheck);
  271.         xvalues = (long *)gs_alloc_byte_array(mem, size, sizeof(long),
  272.                               "get XUID");
  273.         if ( xvalues == 0 )
  274.             return_error(e_VMerror);
  275.         /* Get the values from the XUID array. */
  276.         for ( i = 0; i < size; i++ )
  277.         {    const ref *pvalue = puniqueid->value.const_refs + i;
  278.             if ( !r_has_type(pvalue, t_integer) )
  279.             {    gs_free_object(mem, xvalues, "get XUID");
  280.                 return_error(e_typecheck);
  281.             }
  282.             xvalues[i] = pvalue->value.intval;
  283.         }
  284.         uid_set_XUID(puid, xvalues, size);
  285.         return 1;
  286.     }
  287.     /* If no UniqueID entry, set the UID to invalid, */
  288.     /* because UniqueID need not be present in all fonts, */
  289.     /* and if it is, the legal range is 0 to 2^24-1. */
  290.     if ( dict_find_string(pdict, "UniqueID", &puniqueid) <= 0 )
  291.     {    uid_set_invalid(puid);
  292.         return defaultval;
  293.     }
  294.     else
  295.        {    if ( !r_has_type(puniqueid, t_integer) ||
  296.              puniqueid->value.intval < 0 ||
  297.              puniqueid->value.intval > 0xffffffL
  298.            )
  299.             return_error(e_rangecheck);
  300.         /* Apparently fonts created by Fontographer often have */
  301.         /* a UniqueID of 0, contrary to Adobe's specifications. */
  302.         /* Treat 0 as equivalent to -1 (no UniqueID). */
  303.         if ( puniqueid->value.intval == 0 )
  304.         {    uid_set_invalid(puid);
  305.             return defaultval;
  306.         }
  307.         else
  308.             uid_set_UniqueID(puid, puniqueid->value.intval);
  309.        }
  310.     return 0;
  311. }
  312.  
  313. /* Check that a UID in a dictionary is equal to an existing, valid UID. */
  314. bool
  315. dict_check_uid_param(const ref *pdict, const gs_uid *puid)
  316. {    ref *puniqueid;
  317.     if ( uid_is_XUID(puid) )
  318.       {    uint size = uid_XUID_size(puid);
  319.         uint i;
  320.         if ( dict_find_string(pdict, "XUID", &puniqueid) <= 0 )
  321.           return false;
  322.         if ( !r_has_type(puniqueid, t_array) ||
  323.              r_size(puniqueid) != size
  324.            )
  325.           return false;
  326.         for ( i = 0; i < size; i++ )
  327.           {    const ref *pvalue = puniqueid->value.const_refs + i;
  328.             if ( !r_has_type(pvalue, t_integer) )
  329.               return false;
  330.             if ( pvalue->value.intval != uid_XUID_values(puid)[i] )
  331.               return false;
  332.           }
  333.         return true;
  334.       }
  335.     else
  336.       {    if ( dict_find_string(pdict, "UniqueID", &puniqueid) <= 0 )
  337.           return false;
  338.         return (r_has_type(puniqueid, t_integer) &&
  339.             puniqueid->value.intval == puid->id);
  340.       }
  341. }
  342.  
  343.